<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.masks.Masks</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        <a href="py2ecotect.doc.masks-module.html">Module&nbsp;masks</a> ::
        Class&nbsp;Masks
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.masks.Masks-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Masks</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">Masks</strong>
</pre>

<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#clear" class="summary-sig-name">clear</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Deletes the shading masks list and frees allocated memory.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.clear">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#copy" class="summary-sig-name">copy</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">_from</span>,
        <span class="summary-sig-arg">to</span>)</span><br />
      Copies all day information from one shading mask to another.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.copy">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#interpolate" class="summary-sig-name">interpolate</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">t1</span>,
        <span class="summary-sig-arg">t2</span>,
        <span class="summary-sig-arg">fraction</span>)</span><br />
      Interpolates between the values in two masks and stores them in a new
      mask.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.interpolate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#load" class="summary-sig-name">load</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Loads the shading mask list.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.load">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#save" class="summary-sig-name">save</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Saves the current shading mask list.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.save">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#update" class="summary-sig-name">update</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>)</span><br />
      Updates the specified shading mask's information.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.update">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#add_mask" class="summary-sig-name">add_mask</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">object</span>=<span class="summary-sig-default">0</span>)</span><br />
      Adds a new shading mask to the masks list and returns the zero-based 
      index of the mask just added.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.add_mask">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#get_data" class="summary-sig-name">get_data</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">i</span>,
        <span class="summary-sig-arg">j</span>)</span><br />
      Retrieves the shading value for the specified azimuth and altitude 
      indexes in the sky.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_data">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#set_data" class="summary-sig-name">set_data</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">i</span>,
        <span class="summary-sig-arg">j</span>,
        <span class="summary-sig-arg">value</span>)</span><br />
      Sets the shading value for the specified at the given azimuth and 
      altitude indexes over the sky.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.set_data">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#get_object" class="summary-sig-name">get_object</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>)</span><br />
      Retrieves the zero-based index of the object to which the specified 
      mask belongs.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_object">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#set_object" class="summary-sig-name">set_object</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">object</span>)</span><br />
      Sets the object to which the specified mask will belong.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.set_object">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#get_percentage" class="summary-sig-name">get_percentage</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>)</span><br />
      Returns the percentage-in-shade of the object/mask at the current 
      model date and time as a single decimal percentage value.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_percentage">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#get_percentage_angle" class="summary-sig-name">get_percentage_angle</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">azi</span>,
        <span class="summary-sig-arg">alt</span>)</span><br />
      Returns the percentage-in-shade of the specified mask as a single 
      decimal percentage value from a source located at the given angles.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_percentage_angle">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#get_percentage_datetime" class="summary-sig-name">get_percentage_datetime</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">day</span>,
        <span class="summary-sig-arg">time</span>)</span><br />
      Returns the percentage-in-shade of the selected object's mask as a 
      single decimal percentage value at the given date and time.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_percentage_datetime">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#get_percentage_index" class="summary-sig-name">get_percentage_index</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">x</span>,
        <span class="summary-sig-arg">y</span>)</span><br />
      Returns the percentage-in-shade of the specified object's mask as a 
      single decimal percentage value.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_percentage_index">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#get_shading" class="summary-sig-name">get_shading</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">azi</span>,
        <span class="summary-sig-arg">alt</span>)</span><br />
      Returns the shading value, a decimal value between 0 (unshaded) and 1
      (fully shaded), representing the effective percentage of the exposed 
      surface area of the object that is in shade for the specified sky 
      angles.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_shading">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.masks.Masks-class.html#set_shading" class="summary-sig-name">set_shading</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">azi</span>,
        <span class="summary-sig-arg">alt</span>,
        <span class="summary-sig-arg">value</span>)</span><br />
      Sets the shading value, representing the effective percentage of the 
      object/mask that is in shade using the specified sky angles.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.set_shading">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__init__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.masks.Masks-class.html#count" class="summary-name">count</a><br />
      Returns the number of shading masks in the current list.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="clear"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">clear</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.clear">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Deletes the shading masks list and frees allocated memory. If a future
  calculation requires shading masks, ECOTECT will attempt to re-load them 
  from the cache file on disk.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="copy"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">copy</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">_from</span>,
        <span class="sig-arg">to</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.copy">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Copies all day information from one shading mask to another.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>_from The zero-based index of the shading mask to copy from.</p>
  <p>to The zero-based index of the shading mask to copy to.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="interpolate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">interpolate</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>,
        <span class="sig-arg">t1</span>,
        <span class="sig-arg">t2</span>,
        <span class="sig-arg">fraction</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.interpolate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Interpolates between the values in two masks and stores them in a new 
  mask.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>index The zero-based index of the shading mask where the interpolation
  will be stored.</p>
  <p>t1 The zero-based index of the shading mask from which the 
  interpolation will begin.</p>
  <p>t2 The zero-based index of the shading mask at which the interpolation
  will end.</p>
  <p>fraction The fractional mask bias for the interpolation, typically 
  between 0 (t1) and 1 (t2).</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="load"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">load</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.load">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Loads the shading mask list.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="save"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">save</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.save">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Saves the current shading mask list.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="update"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">update</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.update">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Updates the specified shading mask's information.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>index The zero-based index of the shading mask.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="add_mask"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">add_mask</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">object</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.add_mask">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds a new shading mask to the masks list and returns the zero-based 
  index of the mask just added.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>[object] This optional parameter sets the index to which the new 
  shading mask will be assigned to.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>maskIndex The zero-based index of the new shading mask.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_data"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_data</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>,
        <span class="sig-arg">i</span>,
        <span class="sig-arg">j</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_data">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the shading value for the specified azimuth and altitude 
  indexes in the sky.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The zero-based index of the shading mask.</p>
  <p>i A value between 0 and 71 representing the azimuth angle 
  corresponding to a sky segment.</p>
  <p>j A value between 0 and 17 representing the altitude angle 
  corresponding to a sky segment.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>shading A decimal value between 0 (unshaded) and 1 (fully shaded) 
  representing the effective shading of the object whose shadng mask is 
  specified.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_data"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_data</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>,
        <span class="sig-arg">i</span>,
        <span class="sig-arg">j</span>,
        <span class="sig-arg">value</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.set_data">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the shading value for the specified at the given azimuth and 
  altitude indexes over the sky.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The zero-based index of the shading mask.</p>
  <p>i A value between 0 and 71 representing the azimuth angle as an index 
  corresponding to a sky segment.</p>
  <p>j A value between 0 and 17 representing the altitude angle as an index
  corresponding to a sky segment.</p>
  <p>value A decimal value between 0 (unshaded) and 1 (fully shaded) 
  representing the effective shading of the object whose shading mask is 
  specified.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_object"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_object</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_object">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the zero-based index of the object to which the specified 
  mask belongs.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The zero-based index of the shading mask.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>object The zero-based index of the object.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_object"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_object</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>,
        <span class="sig-arg">object</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.set_object">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the object to which the specified mask will belong. You can use 
  this property to change shading masks at any time during a 
  calculation.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The zero-based index of the shading mask.</p>
  <p>object The zero-based index of the object.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_percentage"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_percentage</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_percentage">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the percentage-in-shade of the object/mask at the current 
  model date and time as a single decimal percentage value.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The zero-based index of the shading mask.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>shading A decimal value between 0 (unshaded) and 100 (fully shaded) 
  representing the effective percentage shading of the object whose shading
  mask is specified.</p>
  <p>cosAngle A decimal fraction representing the effect of direct 
  incidence. This is equal to the cosine of the 3D incidence angle between 
  the centre-point of the sky segment and the surface normal of the object 
  represented by the mask.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_percentage_angle"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_percentage_angle</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>,
        <span class="sig-arg">azi</span>,
        <span class="sig-arg">alt</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_percentage_angle">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the percentage-in-shade of the specified mask as a single 
  decimal percentage value from a source located at the given angles.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The zero-based index of the shading mask.</p>
  <p>azi The azimuth (-180 deg to 180 deg) angle representing, together 
  with the altitude angle, a point in the sky from which to retrieve the 
  value. To retrieve the sun position at any time, use the model.sunangles 
  property.</p>
  <p>alt The altitude (0 deg to 90 deg) angle representing, together with 
  the azimuth angle, a point in the sky from which to retrieve the value. 
  To retrieve the sun position at any time, use the model.sunangles 
  property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>shading A decimal value between 0 (unshaded) and 100 (fully shaded) 
  representing the effective percentage shading of the object whose shading
  mask is specified.</p>
  <p>cosAngle A decimal fraction representing the effect of direct 
  incidence. This is equal to the cosine of the 3D incidence angle between 
  the centre-point of the sky segment and the surface normal of the object 
  represented by the mask.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_percentage_datetime"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_percentage_datetime</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>,
        <span class="sig-arg">day</span>,
        <span class="sig-arg">time</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_percentage_datetime">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the percentage-in-shade of the selected object's mask as a 
  single decimal percentage value at the given date and time.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The zero-based index of the shading mask.</p>
  <p>day The Julian date of the year (1-365) for the percentage value to 
  return.</p>
  <p>time The time of the day to use in decimal hours (0.0-23.99).</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>shading A decimal value between 0 (unshaded) and 100 (fully shaded) 
  representing the effective percentage shading of the object whose shading
  mask is specified.</p>
  <p>cosAngle A decimal fraction representing the effect of direct 
  incidence. This is equal to the cosine of the 3D incidence angle between 
  the centre-point of the sky segment and the surface normal of the object 
  represented by the mask.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_percentage_index"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_percentage_index</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>,
        <span class="sig-arg">x</span>,
        <span class="sig-arg">y</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_percentage_index">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the percentage-in-shade of the specified object's mask as a 
  single decimal percentage value.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The zero-based index of the shading mask.</p>
  <p>x The X index of the shading table, where X is the azimuth angle 
  increment set in the set.shading.angles property.</p>
  <p>y The Y index of the shading table, where Y is the altitude angle 
  increment set in the set.shading.angles property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>shading A decimal value between 0 (unshaded) and 100 (fully shaded) 
  representing the effective percentage shading of the object whose shading
  mask is specified.</p>
  <p>cosAngle A decimal fraction representing the effect of direct 
  incidence. This is equal to the cosine of the 3D incidence angle between 
  the centre-point of the sky segment and the surface normal of the object 
  represented by the mask.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_shading"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_shading</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>,
        <span class="sig-arg">azi</span>,
        <span class="sig-arg">alt</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.get_shading">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the shading value, a decimal value between 0 (unshaded) and 1 
  (fully shaded), representing the effective percentage of the exposed 
  surface area of the object that is in shade for the specified sky 
  angles.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The zero-based index of the shading mask.</p>
  <p>azi The azimuth angle, in degrees, representing the compass direction,
  with North being 0 deg.</p>
  <p>alt The altitude angle with 0 deg representing horizontal direction 
  and 90 deg being vertical.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value, between 0 (unshaded) and 1 (fully shaded).</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_shading"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_shading</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>,
        <span class="sig-arg">azi</span>,
        <span class="sig-arg">alt</span>,
        <span class="sig-arg">value</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.masks-pysrc.html#Masks.set_shading">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the shading value, representing the effective percentage of the 
  object/mask that is in shade using the specified sky angles.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The zero-based index of the shading mask.</p>
  <p>azi The azimuth angle, in degrees, representing the compass direction 
  with North being 0 deg.</p>
  <p>alt The altitude angle with 0 deg representing horizontal direction 
  and 90 deg being vertical.</p>
  <p>value A decimal value, between 0 (unshaded) and 1 (fully shaded).</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="count"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">count</h3>
  <p>Returns the number of shading masks in the current list. If no masks 
  have been loaded, a value of 0 will be returned.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>count The number of shading masks in the list.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Returns the number of shading masks in the current list.
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
